gesture: Add explanatory note in GtkGesture::end
authorCarlos Garnacho <carlosg@gnome.org>
Tue, 6 May 2014 13:23:24 +0000 (15:23 +0200)
committerCarlos Garnacho <carlosg@gnome.org>
Fri, 23 May 2014 17:54:29 +0000 (19:54 +0200)
Explain that this signal may be triggered by an extra touch that causes
the gesture to surpass GtkGesture:n-points.

gtk/gtkgesture.c

index 924b9ced96629997f173f40d6f2d765701b9abbd..fd72f20161c5e9db6de6042ac7857c0591a0020a 100644 (file)
@@ -653,6 +653,11 @@ gtk_gesture_class_init (GtkGestureClass *klass)
    * #FALSE), or the number of touch sequences became higher or lower than
    * #GtkGesture:n-points.
    *
+   * Note: @sequence might not pertain to the group of sequences that were
+   * previously triggering recognition on @gesture (ie. a just pressed touch
+   * sequence that exceeds #GtkGesture:n-points). This situation may be detected
+   * by checking through gtk_gesture_handles_sequence().
+   *
    * Since: 3.14
    */
   signals[END] =